Skip to content

docs: update README download badges - #229

Merged
elkaix merged 1 commit into
mainfrom
docs/readme-download-badges
Aug 28, 2026
Merged

docs: update README download badges#229
elkaix merged 1 commit into
mainfrom
docs/readme-download-badges

Conversation

@elkaix

@elkaix elkaix commented Aug 28, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Related Issue

No issue. This is a maintainer-requested README and badge workflow update.

Problem

The README shows the npm package version as the release and counts only desktop downloads. This
does not match the desktop-focused README or the combined counter on code.pythinker.com.

What changed

  • Show the latest stable desktop release version from PyModel/pythinker-desktop-releases.
  • Publish downloads-total.json as the larger of desktop downloads and npm last-year downloads,
    matching the site formula.
  • Refresh the badge document after this workflow reaches main, while retaining the daily refresh.
  • Remove the license badge without changing the other README badges.

Risk

  • Low. The workflow keeps its existing write boundary on the orphan badges branch.
  • A failed or invalid npm response stops the job before publication, retaining the last valid count.
  • No dependency, telemetry, package, or shipped application changes.

Verification

  • Exact workflow shell run: desktop 550, npm 2857, published downloads 2857.
  • Workflow YAML parse and ShellCheck passed.
  • GitHub Markdown preview rendered release, downloads, platform, Node.js, and visitor badges with no
    license badge.
  • The live release badge and target resolved to v0.3.9.
  • Pre-push Sherif, lint, web-asset freshness, Nix-hash freshness, typecheck, and changed-test gates
    passed.

Rollback and review

  • Rollback: revert this PR. The unused JSON document can remain on the badges branch safely.
  • Residual risk: the new endpoint exists only after the post-merge workflow completes.
  • Human review: confirm the badge source and workflow write scope.

Checklist

  • I have read the CONTRIBUTING document.
  • This maintainer-requested change has no related issue.
  • The documentation/workflow behavior is covered by exact workflow execution and rendering.
  • No changeset is needed for this documentation and CI-only change.
  • No generated documentation update is needed; the README is the canonical target.

Summary by CodeRabbit

  • New Features

    • Added combined desktop and overall download badges.
    • Download badges now reflect desktop release activity.

  • Documentation

    • Updated the release badge to link to desktop releases.
    • Removed the license badge from the README.

@elkaix
docs: update README download badges
fa4cb1a 
Use the desktop release version and the site-matched download count.

Task: README download and desktop release badges.
@coderabbitai

coderabbitai Bot commented Aug 28, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: eeb048a9-a324-492d-ac47-aea1b04783cd

📥 Commits

Reviewing files that changed from the base of the PR and between 370f0fa and fa4cb1a.

📒 Files selected for processing (2)
  • .github/workflows/desktop-download-badges.yml
  • README.md

Included review availability: 6 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 10 reviews per hour.

📝 Walkthrough

Walkthrough

The workflow now generates desktop and combined download badges, including npm counts, and commits the new total endpoint. The README updates its release and download badge links and removes the license badge.

Changes

Download badge refresh

Layer / File(s) Summary
Download endpoint generation
.github/workflows/desktop-download-badges.yml		 The workflow runs when this file changes on main, generates desktop and combined Shields endpoints, retrieves npm download counts with validation and retries, and selects the larger count for downloads-total.json.
Badge publication and README references
.github/workflows/desktop-download-badges.yml, README.md		 The workflow commits the new endpoint with the existing badge files. The README uses desktop release metadata, total downloads, and no license badge.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to fa4cb

This change updates README badges and the badge-refresh workflow without affecting shipped application behavior, dependencies, or package data. No actionable merge-blocking risk remains after normal checks and review.

Sequence Diagram(s)

sequenceDiagram
  participant GitHub as GitHub Actions
  participant Releases as Desktop releases
  participant Npm as npm downloads API
  participant Repository as Repository files
  GitHub->>Releases: Read desktop release assets
  GitHub->>Npm: Retrieve npm download count
  GitHub->>GitHub: Select the larger count
  GitHub->>Repository: Write and commit badge endpoints
  Repository->>Repository: Update README badge references
Loading
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title uses the conventional docs: prefix, uses imperative mood with "update," stays within 72 characters, and accurately describes the README badge changes.
Description check ✅ Passed The description covers the related-issue exception, problem, changes, risks, verification, rollback, review points, and checklist. It is complete for this maintainer-requested documentation and workfl…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description covers the related-issue exception, problem, changes, risks, verification, rollback, review points, and checklist. It is complete for this maintainer-requested documentation and workflow change.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

Comment @coderabbitai help to get the list of available commands.

@pkg-pr-new

pkg-pr-new Bot commented Aug 28, 2026

Copy link
Copy Markdown 
pnpm dlx https://pkg.pr.new/@pymodel/pythinker-code@fa4cb1a

npx https://pkg.pr.new/@pymodel/pythinker-code@fa4cb1a

commit: fa4cb1a

@elkaix
elkaix merged commit 1029712 into main Aug 28, 2026
26 checks passed
@elkaix
elkaix deleted the docs/readme-download-badges branch August 28, 2026 01:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@elkaix